Namespaces

Types in MathNet.Numerics.LinearAlgebra.Solvers

Type CancellationStopCriterion<T>

Namespace MathNet.Numerics.LinearAlgebra.Solvers

Interfaces IIterationStopCriterion<T>

Defines an IIterationStopCriterion<T> that uses a cancellation token as stop criterion.

Constructors

Methods

Properties

Public Constructors

CancellationStopCriterion<T>()

Initializes a new instance of the IterationCountStopCriterion<T> class.

CancellationStopCriterion<T>(CancellationToken masterToken)

Initializes a new instance of the IterationCountStopCriterion<T> class.

Public Methods

void Cancel()

IIterationStopCriterion<T> Clone()

Clones the current IterationCountStopCriterion<T> and its settings.
Return
IIterationStopCriterion<T>

A new instance of the IterationCountStopCriterion`1 class.

IterationStatus DetermineStatus(int iterationNumber, Vector<T> solutionVector, Vector<T> sourceVector, Vector<T> residualVector)

Determines the status of the iterative calculation based on the stop criteria stored by the current IterationCountStopCriterion<T>. Result is set into Status field.
The individual stop criteria may internally track the progress of the calculation based on the invocation of this method. Therefore this method should only be called if the calculation has moved forwards at least one step.
Parameters
int iterationNumber

The number of iterations that have passed so far.

Vector<T> solutionVector

The vector containing the current solution values.

Vector<T> sourceVector

The right hand side vector.

Vector<T> residualVector

The vector containing the current residual vectors.

bool Equals(object obj)

int GetHashCode()

Type GetType()

void Reset()

Resets the IterationCountStopCriterion<T> to the pre-calculation state.

string ToString()

Public Properties

IterationStatus Status get;

Gets the current calculation status.